Package com.cisco.pt.ipc.system.impl
Class OptionsImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.OptionsImpl
Information provided by the PKI file:
\class Options
\brief Options contains the current running options for the application.
\example appWindow().getActiveFile().getOptions()
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionOptionsImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionvoidaddBackgroundImage(String location, String filePath) Information provided by the PKI file:voidaddCustomHideOption(String id, String title, boolean defaultValue) Information provided by the PKI file:voidaddRecentFile(String fullpath) Information provided by the PKI file:voidenableAddToRecentFiles(boolean enable) Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:Information provided by the PKI file:booleangetCustomHideOption(String id, boolean defaultValue) Information provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanbooleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanbooleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanbooleanisSound()Information provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:booleanInformation provided by the PKI file:voidremoveBackgroundImage(String filePath) Information provided by the PKI file:booleanInformation provided by the PKI file:voidsetAccessible(boolean bEnable) Information provided by the PKI file:voidsetAnimation(boolean bEnable) Information provided by the PKI file:voidsetBottomToolbarShown(boolean in) voidsetBufferFullAction(BufferFullAction action) Information provided by the PKI file:voidsetCableInfoPopup(boolean bEnable) Information provided by the PKI file:voidsetCliTabHidden(boolean bEnable) Information provided by the PKI file:voidsetConfigTabHidden(boolean bEnable) Information provided by the PKI file:voidsetCustomHideOption(String id, boolean value) Information provided by the PKI file:voidsetDesktopTabHidden(boolean bEnable) Information provided by the PKI file:voidsetDisableAutoCabling(boolean bEnable) Information provided by the PKI file:voidsetEnableCableLengthEffects(boolean bEnable) Information provided by the PKI file:voidsetEnableExternalNetworkAccess(boolean bEnable) Information provided by the PKI file:voidsetGuiTabHidden(boolean bEnable) Information provided by the PKI file:voidsetHideDevLabel(boolean bEnable, boolean isWorkspaceActive) Information provided by the PKI file:voidsetHideDevModelLabel(boolean bEnable, boolean isWorkspaceActive) Information provided by the PKI file:voidsetHideQoSStamp(boolean bEnable, boolean isWorkspaceActive) Information provided by the PKI file:voidsetIsChallenge_PDUInfo(boolean bEnable) Information provided by the PKI file:voidsetIsDockFirst(boolean bEnable) Information provided by the PKI file:voidsetIsLinkLightShown(boolean bEnable) Information provided by the PKI file:voidsetIsLoggingEnabled(boolean bEnable) Information provided by the PKI file:voidsetIsPortShown(boolean bEnable) Information provided by the PKI file:voidsetMainToolbarShown(boolean in) voidsetPhysicalTabHidden(boolean bEnable) Information provided by the PKI file:voidsetPortNotShownOnMouseOver(boolean bEnable) Information provided by the PKI file:voidsetSecondaryToolbarShown(boolean in) voidsetShowDevTaskbar(boolean bEnable) Information provided by the PKI file:voidsetSound(boolean bEnable) Information provided by the PKI file:voidsetTelephonySound(boolean bEnable) Information provided by the PKI file:voidsetUseCliDefaultTab(boolean bEnable) Information provided by the PKI file:voidsetUseMetric(boolean bMetric) Information provided by the PKI file:Methods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession
-
Constructor Details
-
OptionsImpl
public OptionsImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
isAnimation
public boolean isAnimation()Information provided by the PKI file:
\brief Returns true if animation is enabled, otherwise false. \return bool, true if animation is enabled, otherwise false.- Specified by:
isAnimationin interfaceOptions- Returns:
- boolean Returns a boolean
-
isSound
public boolean isSound()Information provided by the PKI file:
\brief Returns true if sound is enabled, otherwise false. \return bool, true if sound is enabled, otherwise false. -
isTelephonySound
public boolean isTelephonySound()Information provided by the PKI file:
\brief Returns true if telephony sound is enabled, otherwise false. \return bool, true if telephony sound is enabled, otherwise false.- Specified by:
isTelephonySoundin interfaceOptions- Returns:
- boolean Returns a boolean
-
isDockFirst
public boolean isDockFirst()Information provided by the PKI file:
\brief Returns true if dock first is enabled, otherwise false. \remark If dock first is enabled, then dock windows will automatically dock instead of pop up on launch. \return bool, true if dock first is enabled, otherwise false.- Specified by:
isDockFirstin interfaceOptions- Returns:
- boolean Returns a boolean
-
isLoggingEnabled
public boolean isLoggingEnabled()Information provided by the PKI file:
\brief Returns true if logging is enabled, otherwise false. \remark Logs the users IOS commands to memory which can be exported to a text file. \return bool, true if logging is enabled, otherwise false.- Specified by:
isLoggingEnabledin interfaceOptions- Returns:
- boolean Returns a boolean
-
isPortShown
public boolean isPortShown()Information provided by the PKI file:
\brief Returns true if showing of port labels are enabled, otherwise false.. \return bool, true if showing of port labels are enabled, otherwise false.- Specified by:
isPortShownin interfaceOptions- Returns:
- boolean Returns a boolean
-
isPortNotShownOnMouseOver
public boolean isPortNotShownOnMouseOver()Information provided by the PKI file:
\brief Returns true if showing of port labels on mouse over is disabled, otherwise false. \return bool, true if showing of port labels on mouse over is disabled, otherwise false.- Specified by:
isPortNotShownOnMouseOverin interfaceOptions- Returns:
- boolean Returns a boolean
-
isChallenge_PDUInfo
public boolean isChallenge_PDUInfo()Information provided by the PKI file:
\brief Returns true if challenge mode for the PDU info is enabled, otherwise false. \return bool, true if challenge mode for PDU info is enabled, otherwise false.- Specified by:
isChallenge_PDUInfoin interfaceOptions- Returns:
- boolean Returns a boolean
-
isDeviceModelShown
public boolean isDeviceModelShown()Information provided by the PKI file:
\brief Returns true if displaying the device model names is enabled, otherwise false. \return bool, true if displaying device model names are enabled, otherwise false.- Specified by:
isDeviceModelShownin interfaceOptions- Returns:
- boolean Returns a boolean
-
isLinkLightsShown
public boolean isLinkLightsShown()Information provided by the PKI file:
\brief Returns true if displaying the link links are enabled, otherwise false. \return bool, true if displaying the link lights are enabled, otherwise false.- Specified by:
isLinkLightsShownin interfaceOptions- Returns:
- boolean Returns a boolean
-
isAccessible
public boolean isAccessible()Information provided by the PKI file:
\brief Returns true if accessibility is enabled, otherwise false. \remark Accessibility enables screen reader support. \return bool, true if Accessibility is enabled, otherwise false.- Specified by:
isAccessiblein interfaceOptions- Returns:
- boolean Returns a boolean
-
isPhysicalTabHidden
public boolean isPhysicalTabHidden()Information provided by the PKI file:
\brief Returns true if the Physical tabs in device dialogs are shown is enabled, otherwise false. \return bool, true if the Physical tabs in device dialogs are shown is enabled, otherwise false.- Specified by:
isPhysicalTabHiddenin interfaceOptions- Returns:
- boolean Returns a boolean
-
isConfigTabHidden
public boolean isConfigTabHidden()Information provided by the PKI file:
\brief Returns true if the Config tabs in device dialogs are shown is enabled, otherwise false. \return bool, true if the Config tabs in device dialogs are shown is enabled, otherwise false.- Specified by:
isConfigTabHiddenin interfaceOptions- Returns:
- boolean Returns a boolean
-
isCliTabHidden
public boolean isCliTabHidden()Information provided by the PKI file:
\brief Returns true if the CLI tabs in device dialogs are shown is enabled, otherwise false. \return bool, true if the CLI tabs in device dialogs are shown is enabled, otherwise false.- Specified by:
isCliTabHiddenin interfaceOptions- Returns:
- boolean Returns a boolean
-
isDesktopTabHidden
public boolean isDesktopTabHidden()Information provided by the PKI file:
\brief Returns true if the Desktop tabs in device dialogs are shown is enabled, otherwise false. \return bool, true if the Desktop tabs in device dialogs are shown is enabled, otherwise false.- Specified by:
isDesktopTabHiddenin interfaceOptions- Returns:
- boolean Returns a boolean
-
isGuiTabHidden
public boolean isGuiTabHidden()Information provided by the PKI file:
\brief Returns true if the GUI tabs in device dialogs are shown is enabled, otherwise false. \return bool, true if the GUI tabs in device dialogs are shown is enabled, otherwise false.- Specified by:
isGuiTabHiddenin interfaceOptions- Returns:
- boolean Returns a boolean
-
isHideDevModelLabel
public boolean isHideDevModelLabel()Information provided by the PKI file:
\brief Returns true if all device model labels are to be hidden, otherwise false. \return bool, true if all device model labels are to be hidden, otherwise false.- Specified by:
isHideDevModelLabelin interfaceOptions- Returns:
- boolean Returns a boolean
-
isHideDevLabel
public boolean isHideDevLabel()Information provided by the PKI file:
\brief Returns true if all device name labels are to be hidden, otherwise false. \return bool, true if all device name labels are to be hidden, otherwise false.- Specified by:
isHideDevLabelin interfaceOptions- Returns:
- boolean Returns a boolean
-
isHideQoSStamp
public boolean isHideQoSStamp()Information provided by the PKI file:
\brief Returns true if QoS stamps on packets are to be hidden, otherwise false. \return bool, true if QoS stamps on packets are to be hidden, otherwise false.- Specified by:
isHideQoSStampin interfaceOptions- Returns:
- boolean Returns a boolean
-
isEnableCableLengthEffects
public boolean isEnableCableLengthEffects()Information provided by the PKI file:
\brief Returns true if cable length effects are enabled, otherwise false. \return bool, true if cable length effects are enabled, otherwise false.- Specified by:
isEnableCableLengthEffectsin interfaceOptions- Returns:
- boolean Returns a boolean
-
isAutoCablingDisabled
public boolean isAutoCablingDisabled()Information provided by the PKI file:
\brief Returns true if auto cabling is disabled, otherwise false. \return bool, true if auto cabling is disabled, otherwise false.- Specified by:
isAutoCablingDisabledin interfaceOptions- Returns:
- boolean Returns a boolean
-
isUsingMetric
public boolean isUsingMetric()Information provided by the PKI file:
\brief Returns true if using Metric System, otherwise false. \return bool, true if using Metric System, otherwise false.- Specified by:
isUsingMetricin interfaceOptions- Returns:
- boolean Returns a boolean
-
isDevTaskbarShown
public boolean isDevTaskbarShown()Information provided by the PKI file:
\brief Returns true if the device dialog taskbar is shown, otherwise false. \return bool, true if the device dialog taskbar is shown, otherwise false.- Specified by:
isDevTaskbarShownin interfaceOptions- Returns:
- boolean Returns a boolean
-
isExternalNetworkAccessEnabled
public boolean isExternalNetworkAccessEnabled()Information provided by the PKI file:
\brief Returns true if external network access from device scripts is enabled, otherwise false. \return bool, true if external network access from device scripts is enabled, otherwise false.- Specified by:
isExternalNetworkAccessEnabledin interfaceOptions- Returns:
- boolean Returns a boolean
-
isUseCliDefaultTab
public boolean isUseCliDefaultTab()Information provided by the PKI file:
\brief Returns true if the CLI tab is the device default tab, otherwise false. \return bool, true if the CLI tab is the device default tab, otherwise false.- Specified by:
isUseCliDefaultTabin interfaceOptions- Returns:
- boolean Returns a boolean
-
isCableInfoPopup
public boolean isCableInfoPopup()Information provided by the PKI file:
\brief Returns true if the cable info popup in Physical Workspace is shown when mouseover on the cable, otherwise false. \return bool, true if the cable info popup in Physical Workspace is shown when mouseover on the cable, otherwise false.- Specified by:
isCableInfoPopupin interfaceOptions- Returns:
- boolean Returns a boolean
-
getConfigFilePath
Information provided by the PKI file:
\brief Returns the path to the administrative configuration file. \remark This file is the serialization of the settings in this class. \return QString, the path to the administrative configuration file.- Specified by:
getConfigFilePathin interfaceOptions- Returns:
- String Returns a String
-
setAnimation
public void setAnimation(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables animation. \param bEnable, true to enable animation, false to disable it.- Specified by:
setAnimationin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setSound
public void setSound(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables sound. \param bEnable, true to enable sound, false to disable it. -
setTelephonySound
public void setTelephonySound(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables telephony sound. \param bEnable, true to enable telephony sound, false to disable it.- Specified by:
setTelephonySoundin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setIsDockFirst
public void setIsDockFirst(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables dock first. \param bEnable, true to enable dock first, false to disable it. \remark Enabling dock first will cause all new dockable dialogs to be docked when shown.- Specified by:
setIsDockFirstin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setIsLoggingEnabled
public void setIsLoggingEnabled(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables logging. \param bEnable, true to enable logging, false to disable it.- Specified by:
setIsLoggingEnabledin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setIsPortShown
public void setIsPortShown(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables the port label visibility. \param bEnable, true to enable port label visibility, false to disable it.- Specified by:
setIsPortShownin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setPortNotShownOnMouseOver
public void setPortNotShownOnMouseOver(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables the port label visibility on mouse over. \param bEnable, true to enable port label visibility on mouse over, false to disable it.- Specified by:
setPortNotShownOnMouseOverin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setIsChallenge_PDUInfo
public void setIsChallenge_PDUInfo(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables the Challenge Mode in PDU info. \param bEnable, true to enable Challenge Mode in PDU info, false to disable it.- Specified by:
setIsChallenge_PDUInfoin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setAccessible
public void setAccessible(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables accessibility features. \param bEnable, true to enable accessibility features, false to disable it.- Specified by:
setAccessiblein interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setIsLinkLightShown
public void setIsLinkLightShown(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables link light visibility. \param bEnable, true to enable link light visibility, false to disable it.- Specified by:
setIsLinkLightShownin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
addBackgroundImage
Information provided by the PKI file:
\brief Adds a background image file to the list of allowed background images to be used on workspaces. \param QString location, the location to associate with the image. Locations: Building, City, Custom, Intercity, Logical \param QString filePath, the relative path to the file from the application bin folder.- Specified by:
addBackgroundImagein interfaceOptions- Parameters:
location- Takes in a parameter of locationfilePath- Takes in a parameter of filePath
-
removeBackgroundImage
Information provided by the PKI file:
\brief Removes the specified background image file from the list of allowed background images to be used on workspaces. \param QString filePath, the relative path to the file from the application bin folder.- Specified by:
removeBackgroundImagein interfaceOptions- Parameters:
filePath- Takes in a parameter of filePath
-
setPhysicalTabHidden
public void setPhysicalTabHidden(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables the Physical tab visibility. \param bEnable, true to enable Physical tab visibility, false to disable it.- Specified by:
setPhysicalTabHiddenin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setConfigTabHidden
public void setConfigTabHidden(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables the Config tab visibility. \param bEnable, true to enable Config tab visibility, false to disable it.- Specified by:
setConfigTabHiddenin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setCliTabHidden
public void setCliTabHidden(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables the CLI tab visibility. \param bEnable, true to enable CLI tab visibility, false to disable it.- Specified by:
setCliTabHiddenin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setDesktopTabHidden
public void setDesktopTabHidden(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables the Desktop tab visibility. \param bEnable, true to enable Desktop tab visibility, false to disable it.- Specified by:
setDesktopTabHiddenin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setGuiTabHidden
public void setGuiTabHidden(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables the GUI tab visibility. \param bEnable, true to enable GUI tab visibility, false to disable it.- Specified by:
setGuiTabHiddenin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setHideDevModelLabel
public void setHideDevModelLabel(boolean bEnable, boolean isWorkspaceActive) Information provided by the PKI file:
\brief Enables or disables hiding of device model labels. \param bEnable, true to enable hiding of device model labels, false to disable it. \param isWorkspaceActive, true if the workspace is active, false if not.- Specified by:
setHideDevModelLabelin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnableisWorkspaceActive- Takes in a parameter of isWorkspaceActive
-
setHideDevLabel
public void setHideDevLabel(boolean bEnable, boolean isWorkspaceActive) Information provided by the PKI file:
\brief Enables or disables hiding of device name labels. \param bEnable, true to enable hiding of device name labels, false to disable it. \param isWorkspaceActive, true if the workspace is active, false if not.- Specified by:
setHideDevLabelin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnableisWorkspaceActive- Takes in a parameter of isWorkspaceActive
-
setHideQoSStamp
public void setHideQoSStamp(boolean bEnable, boolean isWorkspaceActive) Information provided by the PKI file:
\brief Enables or disables hiding of QoS stamps. \param bEnable, true to enable hiding of QoS stamps, false to disable it. \param isWorkspaceActive, true if the workspace is active, false if not.- Specified by:
setHideQoSStampin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnableisWorkspaceActive- Takes in a parameter of isWorkspaceActive
-
setEnableCableLengthEffects
public void setEnableCableLengthEffects(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables cable length effects. \param bEnable, true to enable cable length effects, false to disable it.- Specified by:
setEnableCableLengthEffectsin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setDisableAutoCabling
public void setDisableAutoCabling(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables auto cabling. \param bEnable, true to disable auto cabling, false to enable it.- Specified by:
setDisableAutoCablingin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setUseMetric
public void setUseMetric(boolean bMetric) Information provided by the PKI file:
\brief Sets whether to use Metric System. \param bMetric, true to use Metric System, false to use Imperial System.- Specified by:
setUseMetricin interfaceOptions- Parameters:
bMetric- Takes in a parameter of bMetric
-
setShowDevTaskbar
public void setShowDevTaskbar(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables the device taskbar. \param bEnable, true to enable the device taskbar, false to disable it.- Specified by:
setShowDevTaskbarin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setEnableExternalNetworkAccess
public void setEnableExternalNetworkAccess(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables external network access from all script modules and device scripts. \param bEnable, true to enable external network access from all script modules and device scripts, false to disable it.- Specified by:
setEnableExternalNetworkAccessin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setUseCliDefaultTab
public void setUseCliDefaultTab(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables the CLI tab as the default tab. \param bEnable, true to enable the CLI tab as the default tab, false to disable it.- Specified by:
setUseCliDefaultTabin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setCableInfoPopup
public void setCableInfoPopup(boolean bEnable) Information provided by the PKI file:
\brief Enables or disables the cable info popup in Physical Workspace when mouseover on the cable. \param bEnable, true to show the cable info popup in Physical Workspace when mouseover on the cable.- Specified by:
setCableInfoPopupin interfaceOptions- Parameters:
bEnable- Takes in a parameter of bEnable
-
setBufferFullAction
Information provided by the PKI file:
\brief Sets the Buffer Full Action option to the specified action. \param action, the Buffer Full Action. Buffer Full Actions: Prompt = 0, AutoClearEventList = 1, AutoViewPreviousEvents = 2- Specified by:
setBufferFullActionin interfaceOptions- Parameters:
action- Takes in a parameter of action
-
getBufferFullAction
Information provided by the PKI file:
\brief Returns the Buffer Full Action option. \return BufferFullAction, the Buffer Full Action. Buffer Full Actions: Prompt = 0, AutoClearEventList = 1, AutoViewPreviousEvents = 2- Specified by:
getBufferFullActionin interfaceOptions- Returns:
- BufferFullAction Returns a BufferFullAction
-
saveFile
Information provided by the PKI file:
\brief Saves this configuration option to a file. \param filename, the filename including the path to save to. \return bool, value is true if the file was saved, false if not. -
getCurrentLanguage
Information provided by the PKI file:
\brief Returns the current language. \return QString, value reperesents the current language.- Specified by:
getCurrentLanguagein interfaceOptions- Returns:
- String Returns a String
-
addCustomHideOption
Information provided by the PKI file:
\brief Adds a custom hide option in the Hide tab of Preferences. \param id, the ID to use for the option. \param title, the title to display for the option. \param defaultValue, true to set is as being in affect, false to not be in effect.- Specified by:
addCustomHideOptionin interfaceOptions- Parameters:
id- Takes in a parameter of idtitle- Takes in a parameter of titledefaultValue- Takes in a parameter of defaultValue
-
setCustomHideOption
Information provided by the PKI file:
\brief Sets a custom hide option in the Hide tab of Preferences. \param id, the ID of the option to set. \param value, true to set is as being in affect, false to not be in effect.- Specified by:
setCustomHideOptionin interfaceOptions- Parameters:
id- Takes in a parameter of idvalue- Takes in a parameter of value
-
getCustomHideOption
Information provided by the PKI file:
\brief Gets a custom hide option in the Hide tab of Preferences. \param id, the ID of the option to get. \param defaultFalue, if the option doesn't exist, the value from this will be returned. \return bool, value is true if the option is on, false if not.- Specified by:
getCustomHideOptionin interfaceOptions- Parameters:
id- Takes in a parameter of iddefaultValue- Takes in a parameter of defaultValue- Returns:
- boolean Returns a boolean
-
isMainToolbarShown
public boolean isMainToolbarShown()- Specified by:
isMainToolbarShownin interfaceOptions- Returns:
- boolean Returns a boolean
-
isSecondaryToolbarShown
public boolean isSecondaryToolbarShown()- Specified by:
isSecondaryToolbarShownin interfaceOptions- Returns:
- boolean Returns a boolean
-
isBottomToolbarShown
public boolean isBottomToolbarShown()- Specified by:
isBottomToolbarShownin interfaceOptions- Returns:
- boolean Returns a boolean
-
setMainToolbarShown
public void setMainToolbarShown(boolean in) - Specified by:
setMainToolbarShownin interfaceOptions- Parameters:
in- Takes in a parameter of in
-
setSecondaryToolbarShown
public void setSecondaryToolbarShown(boolean in) - Specified by:
setSecondaryToolbarShownin interfaceOptions- Parameters:
in- Takes in a parameter of in
-
setBottomToolbarShown
public void setBottomToolbarShown(boolean in) - Specified by:
setBottomToolbarShownin interfaceOptions- Parameters:
in- Takes in a parameter of in
-
enableAddToRecentFiles
public void enableAddToRecentFiles(boolean enable) Information provided by the PKI file:
\brief Enables whether to allow adding to the recent files list in File menu.- Specified by:
enableAddToRecentFilesin interfaceOptions- Parameters:
enable- Takes in a parameter of enable
-
addRecentFile
Information provided by the PKI file:
\brief Adds a file to the recent file list.- Specified by:
addRecentFilein interfaceOptions- Parameters:
fullpath- Takes in a parameter of fullpath
-